home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / SetVar.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  6.8 KB  |  174 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/SetVar.3,v 1.15 93/06/05 15:40:17 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) SetVar.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_SetVar tclc 7.0
  32. .BS
  33. .SH NAME
  34. Tcl_SetVar, Tcl_SetVar2, Tcl_GetVar, Tcl_GetVar2, Tcl_UnsetVar, Tcl_UnsetVar2 \- manipulate Tcl variables
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. char *
  40. \fBTcl_SetVar\fR(\fIinterp, varName, newValue, flags\fR)
  41. .sp
  42. char *
  43. \fBTcl_SetVar2\fR(\fIinterp, name1, name2, newValue, flags\fR)
  44. .sp
  45. char *
  46. \fBTcl_GetVar\fR(\fIinterp, varName, flags\fR)
  47. .sp
  48. char *
  49. \fBTcl_GetVar2\fR(\fIinterp, name1, name2, flags\fR)
  50. .sp
  51. int
  52. \fBTcl_UnsetVar\fR(\fIinterp, varName, flags\fR)
  53. .sp
  54. int
  55. \fBTcl_UnsetVar2\fR(\fIinterp, name1, name2, flags\fR)
  56. .SH ARGUMENTS
  57. .AS Tcl_Interp *newValue
  58. .AP Tcl_Interp *interp in
  59. Interpreter containing variable.
  60. .AP char *varName in
  61. Name of variable.  May refer to a scalar variable or an element of
  62. an array variable.
  63. .AP char *newValue in
  64. New value for variable.
  65. .AP int flags in
  66. OR-ed combination of bits providing additional information for
  67. operation. See below for valid values.
  68. .AP char *name1 in
  69. Name of scalar variable, or name of array variable if \fIname2\fR
  70. is non-NULL.
  71. .AP char *name2 in
  72. If non-NULL, gives name of element within array and \fIname1\fR
  73. must refer to an array variable.
  74. .BE
  75.  
  76. .SH DESCRIPTION
  77. .PP
  78. These procedures may be used to create, modify, read, and delete
  79. Tcl variables from C code.
  80. \fBTcl_SetVar\fR and \fBTcl_SetVar2\fR will create a new variable
  81. or modify an existing one.
  82. Both of these procedures set the given variable to the value
  83. given by \fInewValue\fR, and they return a pointer to a
  84. copy of the variable's new value, which is stored in Tcl's
  85. variable structure.
  86. Tcl keeps a private copy of the variable's value, so the caller
  87. may change \fInewValue\fR after these procedures return without
  88. affecting the value of the variable.
  89. If an error occurs in setting the variable (e.g. an array
  90. variable is referenced without giving an index into the array),
  91. then NULL is returned.
  92. .PP
  93. The name of the variable may be specified in either of two ways.
  94. If \fBTcl_SetVar\fR is called, the variable name is given as
  95. a single string, \fIvarName\fR.
  96. If \fIvarName\fR contains an open parenthesis and ends with a
  97. close parenthesis, then the value between the parentheses is
  98. treated as an index (which can have any string value) and
  99. the characters before the first open
  100. parenthesis are treated as the name of an array variable.
  101. If \fIvarName\fR doesn't have parentheses as described above, then
  102. the entire string is treated as the name of a scalar variable.
  103. If \fBTcl_SetVar2\fR is called, then the array name and index
  104. have been separated by the caller into two separate strings,
  105. \fIname1\fR and \fIname2\fR respectively;  if \fIname2\fR is
  106. zero it means that a scalar variable is being referenced.
  107. .PP
  108. The \fIflags\fR argument may be used to specify any of several
  109. options to the procedures.
  110. It consists of an OR-ed combination of any of the following
  111. bits:
  112. .IP TCL_GLOBAL_ONLY
  113. Under normal circumstances the procedures look up variables
  114. at the current level of procedure call for \fIinterp\fR, or
  115. at global level if there is no call active.
  116. However, if this bit is set in \fIflags\fR then the variable
  117. is looked up at global level even if there is a procedure
  118. call active.
  119. .IP TCL_LEAVE_ERR_MSG
  120. If an error is returned and this bit is set in \fIflags\fR, then
  121. an error message will be left in \fI\%interp->result\fR.  If this
  122. flag bit isn't set then no error message is left (\fI\%interp->result\fR
  123. will not be modified).
  124. .IP TCL_APPEND_VALUE
  125. If this bit is set then \fInewValue\fR is appended to the current
  126. value, instead of replacing it.
  127. If the variable is currently undefined, then this bit is ignored.
  128. .IP TCL_LIST_ELEMENT
  129. If this bit is set, then \fInewValue\fR is converted to a valid
  130. Tcl list element before setting (or appending to) the variable.
  131. A separator space is appended before the new list element unless
  132. .VS
  133. the list element is going to be the first element in a list or
  134. sublist (i.e. the variable's current value is empty, or contains
  135. the single character ``{'', or ends in `` }'').
  136. .VE
  137. .PP
  138. \fBTcl_GetVar\fR and \fBTcl_GetVar2\fR return the current value
  139. of a variable.
  140. The arguments to these procedures are treated in the same way
  141. as the arguments to \fBTcl_SetVar\fR and \fBTcl_SetVar2\fR.
  142. Under normal circumstances, the return value is a pointer
  143. to the variable's value (which is stored in Tcl's variable
  144. structure and will not change before the next call to \fBTcl_SetVar\fR
  145. or \fBTcl_SetVar2\fR).
  146. The only bits of \fIflags\fR that are used are TCL_GLOBAL_ONLY
  147. and TCL_LEAVE_ERR_MSG, both of
  148. which have
  149. the same meaning as for \fBTcl_SetVar\fR.
  150. If an error occurs in reading the variable (e.g. the variable
  151. doesn't exist or an array element is specified for a scalar
  152. variable), then NULL is returned.
  153. .PP
  154. \fBTcl_UnsetVar\fR and \fBTcl_UnsetVar2\fR may be used to remove
  155. a variable, so that future calls to \fBTcl_GetVar\fR or \fBTcl_GetVar2\fR
  156. for the variable will return an error.
  157. The arguments to these procedures are treated in the same way
  158. as the arguments to \fBTcl_GetVar\fR and \fBTcl_GetVar2\fR.
  159. .VS
  160. If the variable is successfully removed then TCL_OK is returned.
  161. If the variable cannot be removed because it doesn't exist then
  162. TCL_ERROR is returned.
  163. .VE
  164. If an array element is specified, the given element is removed
  165. but the array remains.
  166. If an array name is specified without an index, then the entire
  167. array is removed.
  168.  
  169. .SH "SEE ALSO"
  170. Tcl_TraceVar
  171.  
  172. .SH KEYWORDS
  173. array, interpreter, scalar, set, unset, variable
  174.